home *** CD-ROM | disk | FTP | other *** search
/ United Public Domain Gold 4 / United Public Domain Gold 4.iso / tbag / tb032.dms / tb032.adf / Doc-Files / Atree.Doc < prev    next >
Text File  |  1989-06-05  |  21KB  |  463 lines
  1. +-----------------------------------------------------------------------+
  2. | Atree v1.1        Copyright  1989 (pending)                           |
  3. +-----------------------------------------------------------------------+
  4. |                   A directory utility by Don Schmidt                  |
  5. +-----------------------------------------------------------------------+
  6.  
  7. To print Atree.Doc, enter "type > prt: atree.doc" <CR>.
  8.  
  9. Atree v1.1
  10.  
  11. Atree is "freeware" at this time. It may be freely distributed, but not sold, by
  12. anyone. If you acquire the program and like it, please support the
  13. author and become a registered user by sending $10 to:
  14.  
  15.                 Don Schmidt
  16.                 9425 Stanfield Ct.
  17.                 Stockton, Calif.
  18.                 95209
  19.  
  20. The author may be contacted via the Stockton-Modesto Amiga Users Group
  21. (SMAUG) BBS (209) 462-0417, or via Compuserve, ID#: 73520,314.
  22.  
  23. Atree is a disk utility which imitates similar utilities widely available
  24. on IBM compatibles (PC Tools, XTree, QuickDos, etc.). The intent is to allow
  25. the user a graphic representation of the entire (or any portion of the 
  26. entire) directory structure on a disk device, including the files in each
  27. directory, and the capability of moving quickly through the "tree" to a
  28. directory to access its files for purposes of copying, deleting, moving,
  29. viewing, editing, etc.
  30.  
  31. Atree currently supports and will read into memory a directory tree that
  32. has a maximum depth of 65536 directories and no more than 65536 subdirectories
  33. total for the entire tree. (This is because Atree currently supports a
  34. spreadsheet type matrix of 65536 columns, each column representing the
  35. subdirectories of a parent directory and 65536 rows representing a directory
  36. with the first of its children directly to the right of it,
  37. and only a total of 65536 rows currently supported). It is not known how the
  38. program will behave if the total number of directories in a tree exceeds
  39. 65536 or if the depth of the tree exceeds 65536 generations. 
  40.  
  41.  
  42.  
  43. Instructions:
  44.  
  45. NOTE: If you are a first time user of Atree and do not have a file called
  46.       "Atree.Config" in your s: directory, then running Atree will result in
  47.       a requester indicating "Failed: Object not found" -- select "CONTINUE"
  48.       and Atree will continue to load and intialize without problem. You
  49.       should set up your config file during your first session; see instructions
  50.       for the CONFIG menu below.
  51.  
  52. *********************************************
  53. Running the program.
  54. *********************************************
  55.  
  56. Atree Operates only from the CLI. The general format of the command should be:
  57.  
  58. "run atree pathname pathname pathname ......".
  59.  
  60. Examples:
  61.  
  62.     run atree df0: df1: dh0: ram: df1:utilities df1:pictures/flowers
  63.  
  64. The above reads into memory six trees. The first four will be read from
  65. the ROOT directory of the indicated devices, and the last two will be
  66. trees read from the indicated subdirectories of the indicated devices.
  67.  
  68.     run atree dh1: dh1:c_sources dh1:c_objects
  69.  
  70. The above reads into memory the three trees from the same device, dh1:
  71. The first tree will be the entire tree starting with the ROOT directory,
  72. and the second and third will be the subtrees starting with the c_sources
  73. and c_objects directories respectively.
  74.  
  75.     run atree df0: df0: df0:
  76.  
  77. The above reads into memory the entire tree of df0: three times -- no good
  78. reason for doing it, but it can be done.
  79.  
  80.     run atree volume_1: volume_2: volume_3:
  81.  
  82. The above reads the entire tree starting from the ROOT directory of three
  83. disks whose volume names are as indicated. The system will prompt you to
  84. insert the volume in any drive if not already inserted. A two drive system
  85. can thus be used to read into memory the directory trees of more than two
  86. disks and as many as the system's memory will support.
  87.  
  88.     run atree
  89.  
  90. The above command line has no arguments and therefore atree will read into
  91. memory the entire subtree starting from the current directory specified for
  92. the operating system.
  93.  
  94. Reading into memory only the parts or sections of a directory tree may be the
  95. desirable course if you are using a hard disk that has extensive directories
  96. and you only intend to use two or more small portions of the entire tree.
  97.  
  98. As many pathnames may be entered as the command line will support (Total of
  99. 255 characters).
  100.  
  101. ***********************************************
  102. Moving around in the directory and files:
  103. ***********************************************
  104.  
  105. The currently selected directory tree is shown in a large box at the left
  106. of the screen under the word "DIRECTORY:". This box can be thought of as
  107. a window to a larger box containing the entire tree. The entire tree can
  108. be thought of as represented on a large spreadsheet with 65536 rows and 65536
  109. columns. In this spreadsheet, a tree is formed which graphically represents
  110. parent, child and sibling relationships between directories. Children of
  111. the same parent (siblings) will all be in the same column; the parent
  112. of any directory is always in the column to the left, and the children of
  113. any directory are always in the column to the right. Line segments between
  114. directories show how they are related. The directory box at any moment displays
  115. up to five generations (columns) of directories, and up to sixteen rows.
  116.  
  117. You may use either the mouse pointer in combination with the left mouse button,
  118. or the UP, DOWN, RIGHT, and LEFT arrow keys to scroll the directory "window"
  119. to display different sections of the whole tree spreadsheet, as explained
  120. below.
  121.  
  122. To the right of the directory box is another box just under the word "FILES".
  123. This box lists up to sixteen files in the currently highlighted directory.
  124. You may use either the mouse pointer in conjunction with the left mouse
  125. button, or the shifted UP and shifted DOWN arrow keys to scroll through the
  126. entire list of files in the currently highlighted directory, as explained
  127. below.
  128.  
  129. On the display screen, there will always be one directory and one file that
  130. are highlighted. The highlighted file or directory is understood to be the
  131. "argument" or "object" of the various commands you can select from the 
  132. keyboard or menus.
  133.  
  134. Only the first eight (8) characters of directory names are shown in the
  135. directory box; the full name of the currently highlighted directory is
  136. displayed to the right of the word "DIRECTORY:" above the directory
  137. display box.
  138.  
  139. Only the first twenty-five (25) characters of file names are displayed
  140. in the FILES box. To see the full file name, select the RENAME/FILE
  141. option from the ATTRIBUTE menu.
  142.  
  143. Cursor keys alone move the highlighter in the directory box. Shift/UP
  144. Shift/DOWN move the highlighter in the files box.
  145.  
  146. Click left mouse button on any legitimate directory or file and highlighter
  147. will move to it, skipping over anything between.
  148.  
  149. Hold left mouse button down and move pointer -- highlighter will follow
  150. it.
  151.  
  152. Clicking or holding the left button down with pointer close to the
  153. edge of either the directory or files boxes will cause display to scroll
  154. if there is anything to scroll to. 
  155.  
  156. The pointer with button held down functions according to the same rules
  157. as the cursor keys, no matter where on the edge of the screen the pointer
  158. is located. The position of the highlighter is what's important. Thus,
  159. if the highlighter is on a directory at the lower edge of the box
  160. and the directory has no entries in the same column below it, then no
  161. matter where you hold the pointer at the lower edge of the box, no
  162. scrolling will occur. But if you move the highlighter to a directory that
  163. does have entries in the same column below it, then no matter where you hold
  164. the pointer along the lower edge of the directory box, it will scroll.
  165.  
  166. Tag files: Files in a directory can be tagged. The tagged files constitute
  167. a group that can be operated on as a unit for purposes of copying, moving,
  168. deleting, archiving, etc. To tag a file, move highlighter to file and press
  169. space bar (Directories can't be tagged). Once tagged, files remain tagged
  170. until an operation is performed on them. You thus may move to another
  171. directory to perform other operations and return later to the directory
  172. containing tagged files and the files will still be tagged. Tagged files
  173. are marked with the ">" symbol immediately to their left. You may remove
  174. the tag from a file by placing the highlighter over the file and pressing
  175. the space bar.
  176.  
  177. ******************************************************
  178. Using the Atree menus:
  179. ******************************************************
  180.  
  181. Tree Menu:
  182.  
  183.   Read next: changes the currently displayed directory tree by rotating
  184.              through directory trees previously read into memory. Thus,
  185.              if you have read into memory df0:, df1:, and dh0:, then
  186.              selecting this option will cause the "next" tree to be 
  187.              displayed; "next" is determined by the currently displayed
  188.              tree and the order in which the trees were read into memory,
  189.              which, in turn, is determined by the order in which you entered
  190.              the names on the command line.
  191.  
  192.   Get (replace): replaces currently displayed tree with a new one you specify.
  193.  
  194.   Get (new): reads into memory a new tree you specify and displays it. This will
  195.              be a new tree in addition to the others currently read into memory.
  196.              The user can thus read into memory a number of trees limited only
  197.              by available memory after the program has been activated.
  198.  
  199.   Delete: Deletes the currently displayed tree. (You can't delete the
  200.           last or only tree -- there must always be at least one tree).
  201.  
  202.  
  203. Attribute Menu:
  204.  
  205.   Note:       Allows FileNote on highlighted directory/file.
  206.  
  207.   Protection: Allows change of protection status on highlighted directory/
  208.               file.
  209.  
  210.   Rename:     Allows renaming of highlighted file/directory.
  211.  
  212. In all of the above cases, you can select the attribute from the menu
  213. to see or view the current specification and, if you wish, you can click on the
  214. string gadget to alter the current specification. 
  215.  
  216. Directory Menu:
  217.  
  218.   Delete: deletes all files in highlighted directory and deletes directory
  219.           if there are no subdirectories.
  220.  
  221.   Make: creates a subdirectory in the highlighted directory.
  222.  
  223.   Mark Destination: Highlighted directory becomes the target or destination
  224.                     directory for MOVE and COPY functions. Any function
  225.                     requiring a target will not work unless a MARK is set.
  226.  
  227.   Show Destination: In case you have forgotten which directory in which tree
  228.                     you have selected, this option will tell you. You will
  229.                     however only get an abbreviated representation of the
  230.                     complete destination path specification; you will be
  231.                     given the name of your "tree top" (what you specified
  232.                     in order to read this tree) and the name of the
  233.                     directory that is marked as the destination (There may,
  234.                     of course, be more than one directory with the same name
  235.                     in a given tree, so be careful about your assumptions).
  236.                     The complete destination path specification is not given
  237.                     for the simple reason that Atree supports up to a depth
  238.                     of 65536 directories, each of which can have a name up to
  239.                     40 characters long -- that represents a string of 2,621,440
  240.                     characters!
  241.  
  242. File Menu:
  243.  
  244.   Copy, Move and Delete highlighted, tagged, or all files in currently 
  245.     highlighted directories; choices should be obvious.
  246.  
  247.   Archive: Use the Configs menu (see below) to specify the path to your favorite
  248.     archive utility. Then select "Archive" highlighted/tagged/all from the 
  249.     FILE menu. You will be presented with a requester asking you to "Enter
  250.     ARC arguments:". You should enter everything here that you want to
  251.     be added to your path spec for your archive utility, except the
  252.     filename -- this will be added automatically by Atree. The filename 
  253.     added by Atree depends on whether you slected highlighted, tagged, or all.
  254.  
  255.     To make the above clearer with an example:
  256.  
  257.     Suppose you entered "dh2:utilities/arc" as your path spec in the Configs
  258.     menu for your Archive selection. Suppose you now select Archive/highlighted
  259.     from the FILE menu. You get the requester asking you to enter arc arguments.
  260.     Suppose you enter here, "a newarc". Suppose your highlighted file name is
  261.     "this_file". What will happen now is that Atree will execute the command
  262.     line:
  263.  
  264.         run dh2:utilities/arc a newarc this_file
  265.  
  266.     For my particular version of ARC, the above command line will create an
  267.     archive file, newarc.arc, in the current (highlighted) directory (if it
  268.     doesn't already exist) and then will add "this_file" to it.
  269.  
  270.     Selecting "tagged" or "all" instead of "highlighted" will result in the
  271.     above command line being executed over and over for all appropriate
  272.     files.    
  273.     
  274.   Execute: Executes the highlighted file with the RUN command; a command tail
  275.     is requested via a requester and is optional.
  276.  
  277.   Text reader, editor, word processor, IFF displayer and sector editor
  278.     should be obvious, but will not function unless first specified by 
  279.     selecting CONFIGS menu. If specs are made in the CONFIGS menu, the program
  280.     specified  will execute with the RUN command and with the highlighted file
  281.     as the command tail.
  282.  
  283.   NOTE: It is obvious that the user may alter a directory tree or a file
  284.     in many ways without the memory copy of the tree or file list being 
  285.     correspondingly changed. Therefore, through the use of text editors,
  286.     word processors, archive utilities, etc. your memory copy of a tree
  287.     as displayed by Atree at any moment may not correspond to the disk
  288.     it is supposed to represent. The user is advised to update the tree
  289.     by re-reading it using the "Get (replace)" option from the TREE menu.
  290.     Use the same path specification to update your displayed tree to
  291.     keep it in correspondence with the disk it represents.
  292.  
  293. Configs:
  294.  
  295.   Set Path: A requester allows user to specify a path leading to a text reader,
  296.     editor, word processor, IFF display program, or sector editor (or of course
  297.     any program specified). To use the requester set mouse pointer on selection,
  298.     press left mouse button; if a specification was previously set, it will
  299.     now appear in the string gadget at top of requester, otherwise it will be
  300.     blank. To make new specification, set mouse pointer on string gadget,
  301.     press left mouse button and enter text -- press RETURN. When the
  302.     corresponding selection is made via the FILE menu, the specified program
  303.     will be executed with the RUN command and with the highlighted file as
  304.     the command tail.
  305.  
  306.     Thus, suppose you select "Text Reader" and in the string gadget you
  307.     enter "dh2:utilities/blitz". When you now go to the FILE menu and select
  308.     "Text Reader", Atree will execute the following command line:
  309.  
  310.         Run dh2:utilities/blitz <filename>
  311.  
  312.     where <filename> is the currently highlighted file.
  313.  
  314.   Save: Saves the currently specified paths to text reader, editor etc.
  315.     Current colors are also saved. To change colors, use the TREE menu
  316.     and select "Read new" and specify a path that includes a directory
  317.     containing "preferences". Then select "execute" from the FILE menu.
  318.     change your colors with preferences. Quit preferences and then
  319.     select "save" from the CONFIG menu. The new colors, along with any
  320.     other specifications you have made will be saved. The file, Config.Atree,
  321.     is created in the directory specified by the s: assignment. If you are
  322.     a first time user of Atree, and the Config.Atree file does not exist,
  323.     you will get a prompt upon running Atree telling you "object not found"
  324.      -- click on "continue" and the program will proceed with its
  325.     initialization. Set up your config file per the above instructions
  326.     for future running.
  327.  
  328.  
  329. **********************************
  330. Keyboard operation
  331. **********************************
  332.  
  333.  
  334. To the right of each menu choice is a key description to allow the function
  335. to be accessed from the keyboard instead of the menus. Capital letters indicate
  336. of course that the SHIFT key is to be pressed simultaneously to execute the
  337. function. F10 refers to SHIFT/function key #10; f10 is unshifted function
  338. key. the "^" symbol refers to the CONTROL key and must be pressed simul-
  339. taneously with the indicated key.
  340.  
  341. The table below outlines the menu selections and the corresponding keyboard
  342. selections:
  343.  
  344.  
  345. Tree Menu
  346.   Read next                   Esc
  347.   Get (replace)                 =
  348.   Get (new)                     +
  349.   Erase                         -
  350.  
  351. Attribute Menu
  352.   Note/file                     n
  353.   Note/directory                N
  354.   Protext/file                  p
  355.   Protect/directory             P
  356.   Rename/file                   r
  357.   Rename/directory              R
  358.  
  359. Directory Menu
  360.   Delete                 (no key)
  361.   Make                   (no key)
  362.   Mark Destination       (no key)
  363.   Show destination       (no key)
  364.  
  365. File Menu
  366.   Copy/highlighted              c
  367.   Copy/tagged                   C
  368.   Copy/all                     ^c
  369.   Delete/highlighted            d
  370.   Delete/tagged                 D
  371.   Delete/all                   ^d
  372.   Move/highlighted              m
  373.   Move/tagged                   M
  374.   Move/all                     ^m
  375.   Archive/highlighted           a
  376.   Archive/tagged                A
  377.   Archive/all                  ^a
  378.   Execute                      f1
  379.   TextReader                   f2
  380.   TextEditor                   f3
  381.   WordProcessor                f4
  382.   IFFDisplayer                 f5
  383.   SectorEditor                 f6
  384.  
  385. Configs Menu
  386.   SetPaths                      s
  387.   SetBuffer                     S
  388.   Save                         ^s
  389.  
  390.  
  391. *********************************
  392. Future Enhancements:
  393. *********************************
  394.  
  395. The following enhancements to the program are in process and will be included
  396. in the next available revision:
  397.  
  398. 1. Prune -- allow for deletion of all files and directories from highlighted
  399.    directory down -- like pruning a large branch from a tree.
  400.  
  401. 2. Graft -- add to a tree starting at destination marker a given segment of a
  402.    tree; all subdirectories and their files.
  403.  
  404. 3. Go to destination -- Allow user to switch the display to the currently marked
  405.    destination tree and directory.
  406.  
  407. 4. Set place marker -- several of these will be allowed permitting the user to
  408.    mark several places in various trees and later return to them instantly.
  409.  
  410. 5. Go to place marker -- any of the several above, if set.
  411.  
  412. 6. Read (replace) from here down -- alternative to "get (replace)". Allows
  413.    user to specify and read a portion of a tree from the currently highlighted
  414.    directory (a large branch, in other words). 
  415.  
  416. 7. Read (new) from here down -- alternative to "get (new)". Reads a large
  417.    branch of a displayed tree as a new tree.
  418.  
  419. 8. Get disk info -- display free space, volume name, etc.
  420.  
  421. 9. Display total bytes in all files in a directory.
  422.  
  423. 10. Update memory copy of disk tree by:
  424.     
  425.     a. Allowing user to re-read files in a single directory.
  426.  
  427.     b. Automatic check and update of files for ARC, Text Editor, etc.
  428.  
  429. 11. Allow moving and copying files with preservation of original datestamp.
  430.  
  431. 12. Allow user to see total bytes in tagged files.
  432.  
  433. 13. Do auto check before move and copy to see if there is enough disk space.
  434.  
  435. 14. Allow user to search for files in a tree, or all trees.
  436.  
  437.     a. allow specific search pattern.
  438.  
  439.     b. allow wildcards, etc.
  440.  
  441. 15. Allow copy, move, delete to/for a directory specified by the user via
  442.     a requester; user should not always have to read a tree into memory
  443.     in order to copy, move, delete files from it.
  444.  
  445. 16. Allow user to sort files in directories by date, size, or name.
  446.  
  447. 17. Allow user to see how much memory Atree has allocated to hold the
  448.     trees user has read into memory and to display amount of system memory
  449.     still available.
  450.  
  451. 18. Provide support for more utilities to be specified in the CONFIGS menu
  452.     (zoo, pak, etc.).
  453.  
  454. 19. Allow use of Atree from the Workbench.
  455.  
  456. 20. Allow user to set a filespec for display, e.g. display only files with
  457.     ".doc" extension, etc.
  458.  
  459. Whether or not work continues on this program may depend on how well
  460. received the program is by the general public. How well received the
  461. program is will be measured by the number of persons sending money.
  462.  
  463.